<!--$Id: region.so,v 10.33 2005/06/11 12:32:49 bostic Exp $-->
<!--Copyright (c) 1997,2008 Oracle.  All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB Reference Guide: Shared memory regions</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td><b><dl><dt>Berkeley DB Reference Guide:<dd>Environment</dl></b></td>
<td align=right><a href="../env/naming.html"><img src="../../images/prev.gif" alt="Prev"></a><a href="../toc.html"><img src="../../images/ref.gif" alt="Ref"></a><a href="../env/security.html"><img src="../../images/next.gif" alt="Next"></a>
</td></tr></table>
<p align=center><b>Shared memory regions</b></p>
<p>Each of the Berkeley DB subsystems within an environment is described by one
or more regions, or chunks of memory.  The regions contain all of the
per-process and per-thread shared information (including mutexes), that
comprise a Berkeley DB environment.  These regions are created in one of three
types of memory, depending on the flags specified to the
<a href="../../api_c/env_open.html">DB_ENV-&gt;open</a> method:</p>
<ol>
<p><li>If the <a href="../../api_c/env_open.html#DB_PRIVATE">DB_PRIVATE</a> flag is specified to the <a href="../../api_c/env_open.html">DB_ENV-&gt;open</a> method,
regions are created in per-process heap memory; that is, memory returned
by <b>malloc</b>(3).
<p>This flag should not be specified if more than a single process is
accessing the environment because it is likely to cause database
corruption and unpredictable behavior.  For example, if both a server
application and Berkeley DB utilities (for example, <a href="../../utility/db_archive.html">db_archive</a>,
<a href="../../utility/db_checkpoint.html">db_checkpoint</a> or <a href="../../utility/db_stat.html">db_stat</a>) are expected to access the
environment, the <a href="../../api_c/env_open.html#DB_PRIVATE">DB_PRIVATE</a> flag should not be specified.</p>
<p><li>If the <a href="../../api_c/env_open.html#DB_SYSTEM_MEM">DB_SYSTEM_MEM</a> flag is specified to <a href="../../api_c/env_open.html">DB_ENV-&gt;open</a>,
shared regions are created in system memory rather than files.  This is
an alternative mechanism for sharing the Berkeley DB environment among
multiple processes and multiple threads within processes.
<p>The system memory used by Berkeley DB is potentially useful past the lifetime
of any particular process.  Therefore, additional cleanup may be
necessary after an application fails because there may be no way for
Berkeley DB to ensure that system resources backing the shared memory regions
are returned to the system.</p>
<p>The system memory that is used is architecture-dependent.  For example,
on systems supporting X/Open-style shared memory interfaces, such as
UNIX systems, the <b>shmget</b>(2) and related System V IPC
interfaces are used. Additionally, VxWorks systems use system memory.
In these cases, an initial segment ID must be specified by the
application to ensure that applications do not overwrite each other's
database environments, so that the number of segments created does not
grow without bounds.  See the <a href="../../api_c/env_set_shm_key.html">DB_ENV-&gt;set_shm_key</a> method for more
information.</p>
<p>On Windows platforms, the use of the <a href="../../api_c/env_open.html#DB_SYSTEM_MEM">DB_SYSTEM_MEM</a> flag is
problematic because the operating system uses reference counting to
clean up shared objects in the paging file automatically.  In addition,
the default access permissions for shared objects are different from
files, which may cause problems when an environment is accessed by
multiple processes running as different users.  See
<a href="../../ref/build_win/notes.html">Windows Notes</a> for more
information.</p>
<p><li>If no memory-related flags are specified to <a href="../../api_c/env_open.html">DB_ENV-&gt;open</a>, memory
backed by the filesystem is used to store the regions.  On UNIX systems,
the Berkeley DB library will use the POSIX mmap interface. If mmap is not available,
the UNIX shmget interfaces may be used instead, if they are available.
</ol>
<a name="2"><!--meow--></a>
<p>Any files created in the filesystem to back the regions are created in
the environment home directory specified to the <a href="../../api_c/env_open.html">DB_ENV-&gt;open</a> call.
These files are named __db.### (for example, __db.001, __db.002 and
so on).  When region files are backed by the filesystem, one file per
region is created.  When region files are backed by system memory, a
single file will still be created because there must be a well-known
name in the filesystem so that multiple processes can locate the system
shared memory that is being used by the environment.</p>
<p>Statistics about the shared memory regions in the environment can be
displayed using the <b>-e</b> option to the <a href="../../utility/db_stat.html">db_stat</a> utility.</p>
<table width="100%"><tr><td><br></td><td align=right><a href="../env/naming.html"><img src="../../images/prev.gif" alt="Prev"></a><a href="../toc.html"><img src="../../images/ref.gif" alt="Ref"></a><a href="../env/security.html"><img src="../../images/next.gif" alt="Next"></a>
</td></tr></table>
<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
</body>
</html>
